.TH std::filesystem::directory_entry::refresh 3 "2024.06.10" "http://cppreference.com" "C++ Standard Libary"
.SH NAME
std::filesystem::directory_entry::refresh \- std::filesystem::directory_entry::refresh

.SH Synopsis
   void refresh();                               \fB(1)\fP \fI(since C++17)\fP
   void refresh( std::error_code& ec ) noexcept; \fB(2)\fP \fI(since C++17)\fP

   Examines the filesystem object referred to by this directory entry and stores its
   attributes for retrieval with status, exists, is_regular_file, and other status
   accessors.

   If an error occurs, the value of any cached attributes is unspecified.

.SH Parameters

   ec - out-parameter for error reporting in the non-throwing overload

.SH Return value

   \fI(none)\fP

.SH Exceptions

   Any overload not marked noexcept may throw std::bad_alloc if memory allocation
   fails.

   1) Throws std::filesystem::filesystem_error on underlying OS API errors, constructed
   with p as the first path argument and the OS error code as the error code argument.
   2) Sets a std::error_code& parameter to the OS API error code if an OS API call
   fails, and executes ec.clear() if no errors occur.

.SH Notes

   Many low-level OS APIs for directory traversal retrieve file attributes along with
   the next directory entry. The constructors and the non-const member functions of
   std::filesystem::directory_iterator store these attributes, if any, in the
   pointed-to std::filesystem::directory_entry without calling
   directory_entry::refresh, which makes it possible to examine the attributes of the
   directory entries as they are being iterated over, without making additional system
   calls.

.SH Example

    This section is incomplete
    Reason: no example

.SH See also

   status            status of the file designated by this directory entry;
   symlink_status    status of the file/symlink designated by this directory entry
                     \fI(public member function)\fP
                     checks whether directory entry refers to existing file system
   exists            object
                     \fI(public member function)\fP
   is_block_file     checks whether the directory entry refers to block device
                     \fI(public member function)\fP
   is_character_file checks whether the directory entry refers to a character device
                     \fI(public member function)\fP
   is_directory      checks whether the directory entry refers to a directory
                     \fI(public member function)\fP
   is_fifo           checks whether the directory entry refers to a named pipe
                     \fI(public member function)\fP
   is_other          checks whether the directory entry refers to an other file
                     \fI(public member function)\fP
   is_regular_file   checks whether the directory entry refers to a regular file
                     \fI(public member function)\fP
   is_socket         checks whether the directory entry refers to a named IPC socket
                     \fI(public member function)\fP
   is_symlink        checks whether the directory entry refers to a symbolic link
                     \fI(public member function)\fP
   file_size         returns the size of the file to which the directory entry refers
                     \fI(public member function)\fP
                     returns the number of hard links referring to the file to which
   hard_link_count   the directory entry refers
                     \fI(public member function)\fP
                     gets the time of the last data modification of the file to which
   last_write_time   the directory entry refers
                     \fI(public member function)\fP

.SH Category:
     * Todo no example
